home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / ctrrfs.z / ctrrfs
Encoding:
Text File  |  2002-10-03  |  5.8 KB  |  199 lines

  1.  
  2.  
  3.  
  4. CCCCTTTTRRRRRRRRFFFFSSSS((((3333SSSS))))                                                          CCCCTTTTRRRRRRRRFFFFSSSS((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CTRRFS - provide error bounds and backward error estimates for the
  10.      solution to a system of linear equations with a triangular coefficient
  11.      matrix
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE CTRRFS( UPLO, TRANS, DIAG, N, NRHS, A, LDA, B, LDB, X, LDX,
  15.                         FERR, BERR, WORK, RWORK, INFO )
  16.  
  17.          CHARACTER      DIAG, TRANS, UPLO
  18.  
  19.          INTEGER        INFO, LDA, LDB, LDX, N, NRHS
  20.  
  21.          REAL           BERR( * ), FERR( * ), RWORK( * )
  22.  
  23.          COMPLEX        A( LDA, * ), B( LDB, * ), WORK( * ), X( LDX, * )
  24.  
  25. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  26.      These routines are part of the SCSL Scientific Library and can be loaded
  27.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  28.      directs the linker to use the multi-processor version of the library.
  29.  
  30.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  31.      4 bytes (32 bits). Another version of SCSL is available in which integers
  32.      are 8 bytes (64 bits).  This version allows the user access to larger
  33.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  34.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  35.      only one of the two versions; 4-byte integer and 8-byte integer library
  36.      calls cannot be mixed.
  37.  
  38. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  39.      CTRRFS provides error bounds and backward error estimates for the
  40.      solution to a system of linear equations with a triangular coefficient
  41.      matrix. The solution matrix X must be computed by CTRTRS or some other
  42.      means before entering this routine.  CTRRFS does not do iterative
  43.      refinement because doing so cannot improve the backward error.
  44.  
  45.  
  46. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  47.      UPLO    (input) CHARACTER*1
  48.              = 'U':  A is upper triangular;
  49.              = 'L':  A is lower triangular.
  50.  
  51.      TRANS   (input) CHARACTER*1
  52.              Specifies the form of the system of equations:
  53.              = 'N':  A * X = B     (No transpose)
  54.              = 'T':  A**T * X = B  (Transpose)
  55.              = 'C':  A**H * X = B  (Conjugate transpose)
  56.  
  57.      DIAG    (input) CHARACTER*1
  58.              = 'N':  A is non-unit triangular;
  59.              = 'U':  A is unit triangular.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCTTTTRRRRRRRRFFFFSSSS((((3333SSSS))))                                                          CCCCTTTTRRRRRRRRFFFFSSSS((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      N       (input) INTEGER
  75.              The order of the matrix A.  N >= 0.
  76.  
  77.      NRHS    (input) INTEGER
  78.              The number of right hand sides, i.e., the number of columns of
  79.              the matrices B and X.  NRHS >= 0.
  80.  
  81.      A       (input) COMPLEX array, dimension (LDA,N)
  82.              The triangular matrix A.  If UPLO = 'U', the leading N-by-N upper
  83.              triangular part of the array A contains the upper triangular
  84.              matrix, and the strictly lower triangular part of A is not
  85.              referenced.  If UPLO = 'L', the leading N-by-N lower triangular
  86.              part of the array A contains the lower triangular matrix, and the
  87.              strictly upper triangular part of A is not referenced.  If DIAG =
  88.              'U', the diagonal elements of A are also not referenced and are
  89.              assumed to be 1.
  90.  
  91.      LDA     (input) INTEGER
  92.              The leading dimension of the array A.  LDA >= max(1,N).
  93.  
  94.      B       (input) COMPLEX array, dimension (LDB,NRHS)
  95.              The right hand side matrix B.
  96.  
  97.      LDB     (input) INTEGER
  98.              The leading dimension of the array B.  LDB >= max(1,N).
  99.  
  100.      X       (input) COMPLEX array, dimension (LDX,NRHS)
  101.              The solution matrix X.
  102.  
  103.      LDX     (input) INTEGER
  104.              The leading dimension of the array X.  LDX >= max(1,N).
  105.  
  106.      FERR    (output) REAL array, dimension (NRHS)
  107.              The estimated forward error bound for each solution vector X(j)
  108.              (the j-th column of the solution matrix X).  If XTRUE is the true
  109.              solution corresponding to X(j), FERR(j) is an estimated upper
  110.              bound for the magnitude of the largest element in (X(j) - XTRUE)
  111.              divided by the magnitude of the largest element in X(j).  The
  112.              estimate is as reliable as the estimate for RCOND, and is almost
  113.              always a slight overestimate of the true error.
  114.  
  115.      BERR    (output) REAL array, dimension (NRHS)
  116.              The componentwise relative backward error of each solution vector
  117.              X(j) (i.e., the smallest relative change in any element of A or B
  118.              that makes X(j) an exact solution).
  119.  
  120.      WORK    (workspace) COMPLEX array, dimension (2*N)
  121.  
  122.      RWORK   (workspace) REAL array, dimension (N)
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCTTTTRRRRRRRRFFFFSSSS((((3333SSSS))))                                                          CCCCTTTTRRRRRRRRFFFFSSSS((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      INFO    (output) INTEGER
  141.              = 0:  successful exit
  142.              < 0:  if INFO = -i, the i-th argument had an illegal value
  143.  
  144. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  145.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  146.  
  147.      This man page is available only online.
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.